/* =============================================================
 * Your Grandmother's guide to Algorithms
 * =============================================================
 *
 * Copyright (c) 2007, Saverio Miroddi
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the SaverioMiroddiSoftware nor the names of its 
 *       contributors may be used to endorse or promote products derived from 
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 * ---------------------------
 * OrderedTable.java
 * ---------------------------
 *
 */
package dbobjects.tables;

import java.util.Collections;
import java.util.Comparator;

/**
 * Ordering table, using one column.
 * 
 * @author Saverio Miroddi
 */
public class OrderedTable extends Table {
	private final int orderingColPos;
	private final Comparator<String[]> rowComparator;
	
	/**
	 * Public constructor.
	 * 
	 * @param name
	 *            table name.
	 * @param columnDefs
	 *            column definitions.
	 * @param reverse
	 *            true for reverse order, false for natural order.
	 */
	public OrderedTable(int totCols, int orderingColumnPos, boolean reverse) {
		super(totCols);
		this.orderingColPos = orderingColumnPos;
		rowComparator = new RowComparator(reverse);
	}

	/**
	 * Create an ordered table from an unordered one.
	 * 
	 * @param table
	 *            unordered table
	 */
	public OrderedTable(Table table, int orderingColumnPos, boolean reverse) {
		this(table.totCols, orderingColumnPos, reverse);
		for (String[] row: table.rows) insertRow(row);
	}
	
	/**
	 * Ordered insert.
	 */
	@Override
	public void insertRow(String[] newRow) {
		int newPos = Collections.binarySearch(rows, newRow, rowComparator);
		if (newPos < 0) newPos = (newPos * -1) - 1; // correct result
		rows.add(newPos, newRow);
	}

	private class RowComparator implements Comparator<String[]> {
		private final boolean reverse;
		
		public RowComparator(boolean reverse) {
			this.reverse = reverse;
		}
		
		public int compare(String[] leftRow, String[] rightRow) {
			if (reverse) return rightRow[orderingColPos].compareTo(leftRow[orderingColPos]);
			else return leftRow[orderingColPos].compareTo(rightRow[orderingColPos]);			
		}		
	}	
}